From: Andrew Cooper Date: Wed, 26 Aug 2015 09:15:12 +0000 (+0000) Subject: docs: Move xentrace_format.1 to docs/man/xentrace_format.pod.1 X-Git-Tag: archive/raspbian/4.8.0-1+rpi1~1^2~2610 X-Git-Url: https://dgit.raspbian.org/%22http:/www.example.com/cgi/%22https://%22%22/%22http:/www.example.com/cgi/%22https:/%22%22?a=commitdiff_plain;h=014b165f9b9897dd0d0169f2d3aafb6c46436e60;p=xen.git docs: Move xentrace_format.1 to docs/man/xentrace_format.pod.1 And transform to POD to match our other manpages. The content is identical (other than one correction), although the layout differs slightly with certain indentation. As a correction, remove the reference to xentrace_cpusplit(1) which was removed in c/s 9b9ca98b6ab16, more than 10 years ago! Signed-off-by: Andrew Cooper Acked-by: Wei Liu --- diff --git a/docs/man/xentrace_format.pod.1 b/docs/man/xentrace_format.pod.1 new file mode 100644 index 0000000000..e05479a83b --- /dev/null +++ b/docs/man/xentrace_format.pod.1 @@ -0,0 +1,46 @@ +=head1 NAME + +xentrace_format - pretty-print Xen trace data + +=head1 SYNOPSIS + +B [ I ] + +=head1 DESCRIPTION + +B parses trace data in B binary format from +standard input and reformats it according to the rules in a file of +definitions (I), printing to standard output. + +The rules in I should have the format shown below: + +I I I + +Each rule should start on a new line. + +The format string may include format specifiers, such as: +%(cpu)d, %(tsc)d, %(event)d, %(1)d, %(2)d, %(3)d, %(4)d, %(5)d + +[ the `d' format specifier output in decimal, alternatively `x' + will output in hexadecimal and `o' will output in octal ] + +These correspond to the CPU number, event ID, timestamp counter and +the 5 data fields from the trace record. There should be one such +rule for each type of event to be pretty-printed (events which do not +have formatting rules are ignored). + +A sample format file for Xen's predefined trace events is available +in the file tools/xentrace/formats in the Xen source tree. + +Depending on your system and the rate at which trace data is produced, +this script may not be able to keep up with the output of +B if it is piped directly. In these circumstances you +should have B output to a file for processing off-line. + +=head1 AUTHOR + +Mark A. Williamson + +=head1 SEE ALSO + +xentrace(8) diff --git a/tools/xentrace/Makefile b/tools/xentrace/Makefile index 2f57bda5c8..41caccb019 100644 --- a/tools/xentrace/Makefile +++ b/tools/xentrace/Makefile @@ -11,7 +11,6 @@ BIN = $(BIN-y) SBIN = xentrace xentrace_setsize LIBBIN = xenctx SCRIPTS = xentrace_format -MAN1 = $(wildcard *.1) MAN8 = $(wildcard *.8) .PHONY: all @@ -25,7 +24,6 @@ install: build $(INSTALL_DIR) $(DESTDIR)$(bindir) $(INSTALL_DIR) $(DESTDIR)$(sbindir) [ -z "$(LIBBIN)" ] || $(INSTALL_DIR) $(DESTDIR)$(LIBEXEC_BIN) - $(INSTALL_DIR) $(DESTDIR)$(MAN1DIR) $(INSTALL_DIR) $(DESTDIR)$(MAN8DIR) ifneq ($(BIN),) $(INSTALL_PROG) $(BIN) $(DESTDIR)$(bindir) @@ -33,7 +31,6 @@ endif $(INSTALL_PROG) $(SBIN) $(DESTDIR)$(sbindir) $(INSTALL_PYTHON_PROG) $(SCRIPTS) $(DESTDIR)$(bindir) [ -z "$(LIBBIN)" ] || $(INSTALL_PROG) $(LIBBIN) $(DESTDIR)$(LIBEXEC_BIN) - $(INSTALL_DATA) $(MAN1) $(DESTDIR)$(MAN1DIR) $(INSTALL_DATA) $(MAN8) $(DESTDIR)$(MAN8DIR) .PHONY: clean diff --git a/tools/xentrace/xentrace_format.1 b/tools/xentrace/xentrace_format.1 deleted file mode 100644 index 374ec6df70..0000000000 --- a/tools/xentrace/xentrace_format.1 +++ /dev/null @@ -1,44 +0,0 @@ -.TH XENTRACE_FORMAT 1 "11 May 2004" "Xen domain 0 utils" -.SH NAME -xentrace_format \- pretty-print Xen trace data -.SH SYNOPSIS -.B xentrace_format -[ -.I DEFS-FILE -] -.SH DESCRIPTION -.B xentrace_format -parses trace data in \fBxentrace\fP binary format from standard input -and reformats it according to the rules in a file of definitions -(\fIDEFS-FILE\fP), printing to standard output. - -The rules in \fIDEFS-FILE\fP should have the format shown below: - -\fIevent_id\fP \fIwhitespace\fP \fIformat\fP - -Each rule should start on a new line. - -The format string may include format specifiers, such as: -%(cpu)d, %(tsc)d, %(event)d, %(1)d, %(2)d, %(3)d, %(4)d, %(5)d - -[ the `d' format specifier output in decimal, alternatively `x' - will output in hexadecimal and `o' will output in octal ] - -These correspond to the CPU number, event ID, timestamp counter and -the 5 data fields from the trace record. There should be one such -rule for each type of event to be pretty-printed (events which do not -have formatting rules are ignored). - -A sample format file for Xen's predefined trace events is available -in the file tools/xentrace/formats in the Xen source tree. - -Depending on your system and the rate at which trace data is produced, -this script may not be able to keep up with the output of -\fBxentrace\fP if it is piped directly. In these circumstances you -should have \fBxentrace\fP output to a file for processing off-line. - -.SH AUTHOR -Mark A. Williamson - -.SH "SEE ALSO" -xentrace(8), xentrace_cpusplit(1)